Skip to main content
GET
Preview running contracts of revenue policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Estimate of the running contracts the policy would govern if its draft (else its latest published version) were published with include_running_contracts.

matching_count
integer
required

Running contracts of the policy's ledger it would govern: current term started before the version's effective date, not assessed yet on the ledger, and this policy wins the match among the ledger's live policies (priority respected). Each would wait for a reviewer's approval as a transition. A lower bound when is_truncated is true.

Example:

42

recognized_count
integer
required

Among them, the contracts that already recognized revenue in their current term: that revenue stays, only the remainder would follow the policy. A lower bound when is_truncated is true.

Example:

30

is_truncated
boolean
required

True when the scan stopped at its cap (2,000 contracts) and more contracts were not looked at: both counts are then lower bounds.

Example:

false